Package com.cisco.pt.ipc.sim.impl
Class ModuleImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ModuleImpl
Information provided by the PKI file:
\class Port
\brief Port holds and manipulates the ports on devices.
\example network().getDevice("Router0").getPort("FastEthernet0/0")
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionModuleImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddModuleAt(String moduleId, int index) Information provided by the PKI file:voidaddSlot(ModuleType type) Information provided by the PKI file:Information provided by the PKI file:getModuleAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getPortAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getSlotTypeAt(int index) Information provided by the PKI file:voidremoveModuleAt(int index) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
ModuleImpl
public ModuleImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getModuleNumber
public int getModuleNumber()Information provided by the PKI file:
\brief Returns the number of the module. \return int, the number of the module.- Specified by:
getModuleNumberin interfaceModule- Returns:
- int Returns a int
-
getModuleNameAsString
Information provided by the PKI file:
\brief Returns the number of the module. \return string, the module name as a string. Seems to always be "None".- Specified by:
getModuleNameAsStringin interfaceModule- Returns:
- String Returns a String
-
getSlotPath
Information provided by the PKI file:
\brief Returns slot path. \return string, the slot path. For example, "0/0" or "0/1".- Specified by:
getSlotPathin interfaceModule- Returns:
- String Returns a String
-
getModuleType
Information provided by the PKI file:
\brief Returns the module type. \return ModuleType, the number of the module. Types: eLineCard = 0, eNetworkModule = 1, eInterfaceCard = 2, ePtRouterModule = 3, ePtSwitchModule = 4, ePtCloudModule = 5, ePtRepeaterModule = 6, ePtHostModule = 7, ePtModemModule = 8, ePtLaptopModule = 9, ePtTVModule = 10, eIpPhonePowerAdapter = 11, ePtTabletPCModule = 12, ePtPdaModule = 13, ePtWirelessEndDeviceModule = 14, ePtWiredEndDeviceModule = 15, eTrs35 = 16, eUsb = 17, eNonRemovableModule = 18, eASAModule = 19, eASAPowerAdapter = 20, ePtCellTowerModule = 21, ePtIoeModule = 22, ePtIoeNetworkModule = 23, ePtIoeAnalogModule = 24, ePtIoeDigitalModule = 25, ePtIoeCustomIOModule = 26, ePtIoePowerAdapter = 27, ePtIoeMcuComponentPowerAdapter = 28, ePtRouterPowerAdapter = 29, eSfpModule = 30, eAccessPointPowerAdaptor = 31, eNonRemovableInterfaceCard = 32, eCustomModuleType = 2000- Specified by:
getModuleTypein interfaceModule- Returns:
- ModuleType Returns a ModuleType
-
getPortCount
public int getPortCount()Information provided by the PKI file:
\brief Returns the port count. \return int, the number of ports.- Specified by:
getPortCountin interfaceModule- Returns:
- int Returns a int
-
getPortAt
Information provided by the PKI file:
\brief Returns the port at the given index. \param index, index of the port to retrive. \return Port, port at the given index. -
addSlot
Information provided by the PKI file:
\brief Adds a slot of the given type. \param type, Slot type to add. Types: eLineCard = 0, eNetworkModule = 1, eInterfaceCard = 2, ePtRouterModule = 3, ePtSwitchModule = 4, ePtCloudModule = 5, ePtRepeaterModule = 6, ePtHostModule = 7, ePtModemModule = 8, ePtLaptopModule = 9, ePtTVModule = 10, eIpPhonePowerAdapter = 11, ePtTabletPCModule = 12, ePtPdaModule = 13, ePtWirelessEndDeviceModule = 14, ePtWiredEndDeviceModule = 15, eTrs35 = 16, eUsb = 17, eNonRemovableModule = 18, eASAModule = 19, eASAPowerAdapter = 20, ePtCellTowerModule = 21, ePtIoeModule = 22, ePtIoeNetworkModule = 23, ePtIoeAnalogModule = 24, ePtIoeDigitalModule = 25, ePtIoeCustomIOModule = 26, ePtIoePowerAdapter = 27, ePtIoeMcuComponentPowerAdapter = 28, ePtRouterPowerAdapter = 29, eSfpModule = 30, eAccessPointPowerAdaptor = 31, eNonRemovableInterfaceCard = 32, eCustomModuleType = 2000 -
getSlotCount
public int getSlotCount()Information provided by the PKI file:
\brief Returns the total slot count. \return int, the total slot count.- Specified by:
getSlotCountin interfaceModule- Returns:
- int Returns a int
-
getSlotTypeAt
Information provided by the PKI file:
\brief Returns the type of the module at the given index. \param index, index of the module to find the type for. \return ModuleType, the type of the module.- Specified by:
getSlotTypeAtin interfaceModule- Parameters:
index- Takes in a parameter of index- Returns:
- ModuleType Returns a ModuleType
-
removeModuleAt
public void removeModuleAt(int index) Information provided by the PKI file:
\brief Removes the module at the given index. \param index, index of the module to remove. Range (0, getModuleCount - 1).- Specified by:
removeModuleAtin interfaceModule- Parameters:
index- Takes in a parameter of index
-
getModuleCount
public int getModuleCount()Information provided by the PKI file:
\brief Returns the number modules. \return int, the number of modules.- Specified by:
getModuleCountin interfaceModule- Returns:
- int Returns a int
-
getModuleAt
Information provided by the PKI file:
\brief Returns the module at the given index. \param index, index of the module to get. Range (0, getModuleCount - 1). \return Module, the module found at the given index.- Specified by:
getModuleAtin interfaceModule- Parameters:
index- Takes in a parameter of index- Returns:
- Module Returns a Module
-
getOwnerDevice
Information provided by the PKI file:
\brief Returns owner device of the module. \return Device, the device that owns the module.- Specified by:
getOwnerDevicein interfaceModule- Returns:
- Device Returns a Device
-
getDescriptor
Information provided by the PKI file:
\brief Returns the descriptor of the module. Descriptor contains device model, position, etc. \return ModuleDescriptor, the module descriptor.- Specified by:
getDescriptorin interfaceModule- Returns:
- ModuleDescriptor Returns a ModuleDescriptor
-
addModuleAt
Information provided by the PKI file:
\brief Adds a module at the specified location. \param moduleId, module type to add. Something like "NM-2W". \param index, index to add at. \return bool, true if the module was added, false if not.- Specified by:
addModuleAtin interfaceModule- Parameters:
moduleId- Takes in a parameter of moduleIdindex- Takes in a parameter of index- Returns:
- boolean Returns a boolean
-